home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / clasfy17.zip / CLASSIFY.DOC < prev    next >
Text File  |  1992-09-17  |  17KB  |  404 lines
  1.  
  2.                              CLASSIFIED ADS
  3.  
  4.                                   v1.7
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.                             FIDO 1:133/410
  13.  
  14.  
  15.                                 OVERVIEW
  16.                                 ________
  17.  
  18.  
  19.    The CLASSIFIED Ads Door allows your callers to post classified ads in up to
  20.    34 different categories. The categories are defined by you, the Sysop, along
  21.    with the number of days you want the ads to be active. A maintenance program,
  22.    that runs at night in your event, will handle the purging automatically.
  23.  
  24.    Note: There is no limitation to the number of classified ads you can have in
  25.          the database, provided you are running a registered version.
  26.       *  Unregistered version allows for 20 ads.
  27.       *  Unregistered version allows for 15 messages.
  28.  
  29.  
  30.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  31.          created in the directory you run the door from.
  32.  
  33.  
  34.  
  35.                               INSTALLATION
  36.                               ____________
  37.  
  38.  
  39.    Installation is fairly easy and straight-forward. The following steps and
  40.    examples should have you up and running in a very short period of time.
  41.    It is assumed that you are familiar with setting up DOORS on your system.
  42.    To this end, only examples of the configuration file and Door batch file
  43.    are described.
  44.  
  45.       1) Create a directory to hold all CLASSIFY files
  46.  
  47.       2) Unzip CLASFYxx.ZIP into the the above directory
  48.  
  49.          NOTE: BRUN45.EXE is not included but is required !!!
  50.  
  51.       3) Create a configuration file, with a name of your choice, or
  52.          modify the supplied CLASSIFY.CFG file. A description follows:
  53.  
  54.             **                       Location of system file (See Below)
  55.             SUNRISE-80 BBS           Your BBS Name
  56.             Al                       Sysop's First nameAP
  57.  
  58.             Lawrence                 Sysop's Last Name
  59. |-----------------------------------------------------------------------------|
  60. | READ!     1                        CommPort  \ These 2 lines are required   |
  61. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  62. |-----------------------------------------------------------------------------|
  63.  
  64.             00000000                 Registration Number
  65.  
  66.         #   2                        Keyboard timeout value in Minutes
  67.  
  68.  
  69.         #   NONE                     Drive:\Path\Filename to contain the
  70.                                      Bulletin summarizing all classified
  71.                                      ads in the database.
  72.  
  73.             Y                        Y=Display the Originating BBS Name
  74.                                      N=Do Not Display the Originating BBS Name
  75.  
  76.             N                        Y =  Use European Date Format (DDMMYY)
  77.                                      N =  Use Regular  Date Format (MMDDYY)
  78.  
  79.             0                        Minimum Logon Security Level required to
  80.                                      enter a new AD option. Zero(0) will 
  81.                                      allow access to everyone.
  82.  
  83.             0                        Minimum Logon Security Level required to
  84.                                      access the DELETE option. Zero(0) will 
  85.                                      allow access to everyone.
  86.  
  87.             0                        Minimum Logon Security Level required to
  88.                                      access the MODIFY option. Zero(0) will 
  89.                                      allow access to everyone.
  90.  
  91.             0                        Minimum Logon Security Level required to
  92.                                      access the MESSAGES option. Zero(0) will 
  93.                                      allow access to everyone.
  94.  
  95.             00000000                 Ads Exchange Program Registration Number
  96.      
  97.               ** = Replace with ONE of the following:
  98.  
  99. C:\BBS\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  100. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  101. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  102.                                    (Note:DOOR.SYS must be in SAME directory)
  103. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  104. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  105. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  106. C:\BBS\CHAIN.TXT                <- For WWIV systems 
  107. C:\BBS\GTUSER.BBS               <- For GT Power 
  108.                                    * if using this option you must put the
  109.                                      ComPort # on line 5 and the Node # on
  110.                                      line 6 of the configuration file
  111.  
  112.  
  113.  
  114.            # = Requires registration to change to a different value.
  115.  
  116.                NOTE: There are NO Blank Lines in the Config File!!
  117.  
  118.  
  119.  
  120.  
  121.       4) Create a batch file or modify the CLASSIFY file supplied. A
  122.          description of this file follows:
  123.  
  124.             ECHO off
  125.             cd\BBS\DOORS\CLASSIFY     Location of CLASSIFY files
  126.             CLASSIFY CLASSIFY.CFG     EXE filename and CFG filename (Name
  127.                                       used in creating file in #3 above)
  128.             CD\BBS
  129.             BOARD
  130.  
  131.  
  132.        5) When running in more than one node, be sure to supply a
  133.           different configuration name for each node (your choice of name).
  134.  
  135.  
  136.  
  137.                           RESTRICTIONS!
  138.                           -------------
  139.  
  140.           UnRegistered versions of CLASSIFY limit the number of messages
  141.           in the database to 15 and the number of ads to 20.
  142.  
  143.  
  144.  
  145.  
  146.                         CATEGORY FILE (Classify.CAT)
  147.                         ----------------------------
  148.  
  149.        Be sure to give a lot of thought to your choice of categories, since
  150.        the category position in this file is carried in each Ad record. This
  151.        means, if you set up the categories so that #2 was 'Want Ads - General'
  152.        and the caller entered an Ad under that category, the Ad would carry
  153.        category #2 as the category number. If you then decide that you want to
  154.        change the 'Want Ad - General' category to say, 'Announcements', then 
  155.        the Ads carrying #2 in their record would be classified incorrectly.
  156.  
  157.                The format of the Classify.Cat file follows:
  158.  
  159.                               wwwwwwww,xx,y,z
  160.  
  161.                Where w = Category name. Max length: 25 characters
  162.                      x = Number of days to remain active. Min:1 Max 365
  163.                      y = Should the program ask for COST ($$$) info. You
  164.                          would answer Y for a For Sale type category and
  165.                          an N for a WANT AD or Announcment type category.
  166.                      z = Category security level. If caller's logon security
  167.                          level is less than this security level, they will not
  168.                          be able to enter or view an ad in this category. A
  169.                          category security level of 0 allows anyone access.
  170.  
  171.           NOTE: Maximum number of entries is 34.
  172.  
  173.  
  174.                         WELCOME and GOODBYE Files
  175.                         -------------------------
  176.       The following applies to registered versions of CLASSIFY ONLY!
  177.  
  178.       If the program finds a file called WELCOME, it will display that file 
  179.       after the opening screen and before the main menu screens. WELCOME must
  180.       reside in the same directory as CLASSIFY.EXE
  181.  
  182.       If the program finds a file called GOODBYE, it will display that file 
  183.       when the caller exits the program. It will display prior to displaying
  184.       the file called ADOPT.SYS (if you have created it). GOODBYE must reside
  185.       in the same directory as CLASSIFY.EXE
  186.  
  187.  
  188.                            AUTOMATED PURGING
  189.                            -----------------
  190.  
  191.       When you set up the categories to be used in your version of CLASIFIEDS,
  192.       you are asked to define the number of days the ad should remain active.
  193.       By running the CLPURGE program in your nightly event process you will 
  194.       ensure that the ads are deleted, automatically. 
  195.  
  196.       In addition CLPURGE will pack the Message Database and delete all
  197.       messages that have been read.
  198.  
  199.       The following is all that is required to execute the purge:
  200.  
  201.                          CLPURGE CLASSIFY.CFG
  202.                                  ^^^^^^^^^^^^
  203.                                      |
  204.                                      |------ or whatever you call the CFG file
  205.  
  206.        Note: This is only available in registered versions!
  207.  
  208.  
  209.  
  210.                            DATABASE EXCHANGE
  211.                            _________________
  212.  
  213.      
  214.       The optional Classified Ads Database Exchange feature will allow you
  215.       to participate in the exchange of Classified Ads databases with other
  216.       BBS' (Any number of BBS' can participate). The exchange program is 
  217.       named CLEXCH and comes included in the CLASFYxx.ZIP file.
  218.  
  219.       CLEXCH performs two (2) major functions:
  220.  
  221.      (1) EXPORT:  Extracts all active ads from the Classified Ads database. 
  222.                   It creates a file named CLASSIFY.EXP and will bypass any 
  223.                   ad already flagged for deletion.
  224.  
  225.      (2) IMPORT:  Imports the CLASSIFY.EXP file created by the EXPORT option
  226.                   and merges all ads into the Classified Ads database. It will
  227.                   not import any ads that duplicates ads found in the 
  228.                   existing database.
  229.  
  230.      All BBS' involved in the exchange MUST run registered versions of BOTH 
  231.      Classified Ads and Classified Exchange (CLEXCH). CLEXCH will only work 
  232.      with version 1.4 of CLASSIFY or later!
  233.  
  234.      It is critical that ALL participants in the exchange use the SAME 
  235.      Category file. Failure to do so will result in ads meant for a certain
  236.      category on one system, showing up in a category totally unrelated on 
  237.      another system.
  238.  
  239.      To run the Exchange you do the following:
  240.  
  241.      EXPORT:  a) Change to the directory containing your CLASSIFY.DAT file
  242.               b) Issue this command:  CLEXCH EXPORT CLASSIFY.CFG
  243.                  If you use a different name for your Config file, then 
  244.                  substitute that name for CLASSIFY.CFG
  245.               c) Send (transmit) the CLASSIFY.EXP file to those invoved 
  246.                  in the exchange.
  247.               d) Delete CLASSIFY.EXP
  248.  
  249.      IMPORT:  a) Change to the directory containing your CLASSIFY.DAT file
  250.               b) Copy the CLASSIFY.EXP file that was sent to you by the 
  251.                  BBS you are exchanging with, to the directory used in a)
  252.               c) Issue the command:   CLEXCH IMPORT CLASSIFY.CFG
  253.                  If you use a different name for your Config file, then 
  254.                  substitute that name for CLASSIFY.CFG
  255.               d) Delete CLASSIFY.EXP
  256.     
  257.    NOTE: When registering CLEXCH, you MUST use the EXACT SAME Sysop Name
  258.          AND BBS NAME as used for CLASSIFIED ADS!!!!!!!!!!!!!!!!!!!!!!!!!
  259.  
  260.  
  261.                         NON-STANDARD COM SUPPORT
  262.                         ________________________
  263.  
  264.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  265.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  266.       number after the configuration filename. Let's assume your Door is
  267.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  268.       passed to your Door would be:
  269.  
  270.                             FOOBAR FOOBAR.CFG /5
  271.  
  272.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  273.       normally used with COM1. No /x parameter is needed for the standard
  274.       IRQ's.
  275.  
  276.       As an alternative, you may use an environmental variable on the command
  277.       line. To use the variable (following the example above), place a 
  278.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a 
  279.       different IRQ number for each node). The command line would now look 
  280.       like this: 
  281.  
  282.                           FOOBAR FOOBAR.CFG /%IRQ%
  283.       
  284.       This, in combination with the use of the environmental variables 
  285.       described in the MULTI-NODE SETUP section will allow you to use one 
  286.       batch file and one config file to run this door on all nodes.
  287.  
  288.  
  289.  
  290.  
  291.                            MULTI-NODE SETUP
  292.                            ________________
  293.  
  294.       All Sunrise Doors are Multi-Node capable. Each node must have the 
  295.       ability to access a configuration file which will have its own system 
  296.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first 
  297.       line. There are 2 ways to accomplish this:
  298.  
  299.       (1) Create a separate configuration file for each node. The only 
  300.           difference between each file would be the location of the system 
  301.           file for that particular node. For example, on my system there are 2
  302.           nodes and the first line of the config files would look like this:
  303.  
  304.                         NODE1:  H:\PCB1\DOOR.SYS
  305.                         NODE2:  H:\PCB2\DOOR.SYS
  306.  
  307.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  308.  
  309.       (2) Use ONE configuration file for ALL nodes. This Door will recognize 
  310.           the following PCBoard environmental variables:
  311.  
  312.                  PCBDIR    (Directory containing the System file)
  313.                  PCBDRIVE  (Drive containing the System file)
  314.  
  315.           Thus, the first line of the SINGLE configuration file, for this Door
  316.           would look like this:
  317.  
  318.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  319.  
  320.       NOTE: This option, as described, assumes that you are running PCBoard 
  321.             14.5a software. The environmental variables are automatically 
  322.             created by the software for each node.
  323.  
  324.             HOWEVER, if you are running other BBS software you should be able
  325.             to set the variables EXACTLY as described below, for EACH node 
  326.             (more than likely in each batch file you use to bring up EACH node):
  327.  
  328.                             PCBDRIVE=C:
  329.                             ^^^^^^^^^
  330.                             PCBDIR=\NODE2
  331.                             ^^^^^^^^
  332.             
  333.             Info with a carat (^) under it, MUST be typed as is. The rest 
  334.             depends on your naming conventions. 
  335.  
  336.             This, in combination with the use of the optional environmental
  337.             variable described in the NON-STANDARD COM SUPPORT section, will
  338.             allow you to use one batch file and one config file to run this 
  339.             door on all nodes.
  340.  
  341.  
  342.  
  343.                               LEGALITIES
  344.                               __________
  345.  
  346.  
  347.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  348.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  349.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  350.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  351.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  352.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  353.       OR BREACH OF ANY WARRANTY.
  354.  
  355.  
  356.  
  357.  
  358.  
  359.                              DISTRIBUTION
  360.                              ____________
  361.  
  362.    You may make this file available for downloading from your BBS or you may
  363.    upload it to any BBS of your choice, provided that you do not make any
  364.    changes to the contents of the archive (ZIP file). The archive and its
  365.    individual contents may not be used by any service that charges any money
  366.    whatsoever, without the written permission of the author.
  367.  
  368.  
  369.  
  370.  
  371.  
  372.                              REGISTRATION
  373.                              ____________
  374.  
  375.    Registration and the subsequent insertion of the registration number into
  376.    your configuation file, allows for the display of your BBS name on the
  377.    opening and closing screen as well as the reduction of a delay built into
  378.    the opening screen display along with the ability to change certain
  379.    values in the configuration file.
  380.  
  381.    To register your copy of CLASSIFY, please fill out the registration form
  382.    (REGISTER.FRM) and mail it along with a small donation ($20,25,etc) to
  383.    the name and address on the form.
  384.  
  385.    Be sure to use the proper upper/lower case when filling in your name and
  386.    BBS name, as they MUST match the way you entered them in the configuration
  387.    file.             ^^^^
  388.  
  389.    Based upon information supplied on the registration form, I will pre-
  390.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  391.    up your registration number.
  392.  
  393.  
  394.  
  395.                                  MISC
  396.                                  ____
  397.  
  398.    The latest version of CLASSIFIED ADS and other fine SUNRISE DOOR programs
  399.    are always available for download from SUNRISE-80 BBS.
  400.  
  401.    Remember, should you have any problems, questions or suggestions, be sure
  402.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors, 
  403.    PCBHints, SYSops) or on SMARTNET (SN_Sysops) or FIDO 1:133/410.
  404.